<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: D:/Projects/MiXiM/extsrc/mixim/src/modules/mac/UWBIRMac.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00438.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">UWBIRMac.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode:c++ -*- ********************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * file:        UWBIRMac.h</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * author:      Jerome Rousselot &lt;jerome.rousselot@csem.ch&gt;</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * copyright:   (C) 2008-2009 Centre Suisse d&#39;Electronique et Microtechnique (CSEM) SA</span>
<a name="l00007"></a>00007 <span class="comment"> *        Systems Engineering</span>
<a name="l00008"></a>00008 <span class="comment"> *              Real-Time Software and Networking</span>
<a name="l00009"></a>00009 <span class="comment"> *              Jaquet-Droz 1, CH-2002 Neuchatel, Switzerland.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> *              This program is free software; you can redistribute it</span>
<a name="l00012"></a>00012 <span class="comment"> *              and/or modify it under the terms of the GNU General Public</span>
<a name="l00013"></a>00013 <span class="comment"> *              License as published by the Free Software Foundation; either</span>
<a name="l00014"></a>00014 <span class="comment"> *              version 2 of the License, or (at your option) any later</span>
<a name="l00015"></a>00015 <span class="comment"> *              version.</span>
<a name="l00016"></a>00016 <span class="comment"> *              For further information see file COPYING</span>
<a name="l00017"></a>00017 <span class="comment"> *              in the top level directory</span>
<a name="l00018"></a>00018 <span class="comment"> * description: All MAC designed for use with UWB-IR should derive from this</span>
<a name="l00019"></a>00019 <span class="comment"> *        class. It provides the necessary functions to build UWBIR</span>
<a name="l00020"></a>00020 <span class="comment"> *        packets and to receive them.</span>
<a name="l00021"></a>00021 <span class="comment"> ***************************************************************************/</span>
<a name="l00022"></a>00022 <span class="comment">//</span>
<a name="l00023"></a>00023 <span class="comment">// See the following publications for more information:</span>
<a name="l00024"></a>00024 <span class="comment">// [1] An Ultra Wideband Impulse Radio PHY Layer Model for Network Simulation,</span>
<a name="l00025"></a>00025 <span class="comment">// J. Rousselot, J.-D. Decotignie, Simulation: Transactions of the Society</span>
<a name="l00026"></a>00026 <span class="comment">// for Computer Simulation, 2010 (submitted).</span>
<a name="l00027"></a>00027 <span class="comment">// [2] A High-Precision Ultra Wideband Impulse Radio Physical Layer Model</span>
<a name="l00028"></a>00028 <span class="comment">// for Network Simulation, Jérôme Rousselot, Jean-Dominique Decotignie,</span>
<a name="l00029"></a>00029 <span class="comment">// Second International Omnet++ Workshop,Simu&#39;TOOLS, Rome, 6 Mar 09.</span>
<a name="l00030"></a>00030 <span class="comment">// http://portal.acm.org/citation.cfm?id=1537714</span>
<a name="l00031"></a>00031 <span class="comment">//</span>
<a name="l00032"></a>00032 <span class="preprocessor">#ifndef UWBIRMAC_H</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define UWBIRMAC_H</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include &quot;MiXiMDefs.h&quot;</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include &quot;BaseMacLayer.h&quot;</span>
<a name="l00037"></a>00037 <span class="preprocessor">#include &quot;IEEE802154A.h&quot;</span>
<a name="l00038"></a>00038 <span class="preprocessor">#include &quot;Packet.h&quot;</span>
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="keyword">class </span><a class="code" href="a00134.html" title="Defines the methods provided by the phy to the mac layer.">MacToPhyInterface</a>;
<a name="l00041"></a>00041 <span class="keyword">class </span><a class="code" href="a00224.html">UWBIRMacPkt</a>;
<a name="l00042"></a>00042 
<a name="l00053"></a><a class="code" href="a00223.html">00053</a> <span class="keyword">class </span>MIXIM_API <a class="code" href="a00223.html" title="This class provides helper function for MAC modules that use the UWB-IR IEEE 802.15.4A model.">UWBIRMac</a> : <span class="keyword">public</span> <a class="code" href="a00026.html" title="A very simple MAC module template which provides de- and encapsulation of messages using the standard...">BaseMacLayer</a> {
<a name="l00054"></a>00054 <span class="keyword">private</span>:
<a name="l00057"></a>00057     <a class="code" href="a00223.html" title="This class provides helper function for MAC modules that use the UWB-IR IEEE 802.15.4A model.">UWBIRMac</a>(<span class="keyword">const</span> <a class="code" href="a00223.html" title="This class provides helper function for MAC modules that use the UWB-IR IEEE 802.15.4A model.">UWBIRMac</a>&amp;);
<a name="l00060"></a>00060     <a class="code" href="a00223.html" title="This class provides helper function for MAC modules that use the UWB-IR IEEE 802.15.4A model.">UWBIRMac</a>&amp; <a class="code" href="a00026.html#aac78343ae4c96940669323e51ec09ada" title="Assignment operator is not allowed.">operator=</a>(<span class="keyword">const</span> <a class="code" href="a00223.html" title="This class provides helper function for MAC modules that use the UWB-IR IEEE 802.15.4A model.">UWBIRMac</a>&amp;);
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 <span class="keyword">public</span>:
<a name="l00063"></a>00063 
<a name="l00064"></a>00064     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00026.html#a61c82dc3b225eac37f7fa9936c28c2c3" title="Initialization of the module and some variables.">initialize</a>(<span class="keywordtype">int</span> stage);
<a name="l00065"></a>00065 
<a name="l00066"></a>00066     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00025.html#a5ab11502dbeeea89693d29841376a2f7" title="Called when the simulation has finished.">finish</a>();
<a name="l00067"></a>00067 
<a name="l00068"></a>00068     <a class="code" href="a00223.html" title="This class provides helper function for MAC modules that use the UWB-IR IEEE 802.15.4A model.">UWBIRMac</a>()
<a name="l00069"></a>00069       : <a class="code" href="a00026.html" title="A very simple MAC module template which provides de- and encapsulation of messages using the standard...">BaseMacLayer</a>()
<a name="l00070"></a>00070       , <a class="code" href="a00027.html#af32711ea117b066fcd10081a17bb81d4" title="Debug switch for all other modules.">debug</a>(<span class="keyword">false</span>)
<a name="l00071"></a>00071       , stats(<span class="keyword">false</span>)
<a name="l00072"></a>00072       , trace(<span class="keyword">false</span>)
<a name="l00073"></a>00073       , rsDecoder(<span class="keyword">false</span>)
<a name="l00074"></a>00074       , packetsAlwaysValid(<span class="keyword">false</span>)
<a name="l00075"></a>00075       , totalRxBits(0), errRxBits(0)
<a name="l00076"></a>00076       , <a class="code" href="a00026.html#aa7b1e6bdb734765a9f4eff7d486dfbea" title="Handler to the physical layer.">phy</a>(NULL)
<a name="l00077"></a>00077       , packet(100)
<a name="l00078"></a>00078       , prf(0)
<a name="l00079"></a>00079       , packetsBER()
<a name="l00080"></a>00080       , dataLengths()
<a name="l00081"></a>00081       , erroneousSymbols()
<a name="l00082"></a>00082       , sentPulses()
<a name="l00083"></a>00083       , receivedPulses()
<a name="l00084"></a>00084       , meanPacketBER()
<a name="l00085"></a>00085       , packetSuccessRate()
<a name="l00086"></a>00086       , packetSuccessRateNoRS()
<a name="l00087"></a>00087       , ber()
<a name="l00088"></a>00088       , meanBER()
<a name="l00089"></a>00089       , RSErrorRate()
<a name="l00090"></a>00090       , success(), successNoRS()
<a name="l00091"></a>00091       , nbReceivedPacketsNoRS(0), nbReceivedPacketsRS(0), nbSentPackets(0), nbSymbolErrors(0)
<a name="l00092"></a>00092       , nbSymbolsReceived(0), nbHandledRxPackets(0), nbFramesDropped(0)
<a name="l00093"></a>00093     { }
<a name="l00094"></a>00094 
<a name="l00095"></a>00095 <span class="keyword">protected</span>:
<a name="l00096"></a><a class="code" href="a00223.html#a03036f082beb5171b39a36a76cda36bf">00096</a>     <span class="keywordtype">bool</span> <a class="code" href="a00223.html#a03036f082beb5171b39a36a76cda36bf" title="Debug switch for all other modules.">debug</a>;
<a name="l00097"></a>00097     <span class="keywordtype">bool</span> stats;
<a name="l00098"></a>00098     <span class="keywordtype">bool</span> trace;
<a name="l00099"></a>00099     <span class="keywordtype">bool</span> rsDecoder;
<a name="l00100"></a>00100     <span class="keywordtype">bool</span> packetsAlwaysValid;
<a name="l00101"></a>00101     <span class="keywordtype">double</span> totalRxBits, errRxBits; <span class="comment">// double and not long as we divide one by the other to get the BER</span>
<a name="l00102"></a><a class="code" href="a00223.html#a11441696168ae8b05f3d5bb899478656">00102</a>     <a class="code" href="a00134.html" title="Defines the methods provided by the phy to the mac layer.">MacToPhyInterface</a>* <a class="code" href="a00223.html#a11441696168ae8b05f3d5bb899478656" title="Handler to the physical layer.">phy</a>;
<a name="l00103"></a>00103     <a class="code" href="a00168.html" title="Class that keeps track of the number of packets sent.">Packet</a> packet;
<a name="l00104"></a>00104     <span class="keywordtype">int</span> prf; <span class="comment">// pulse repetition frequency</span>
<a name="l00105"></a>00105     cOutVector packetsBER;
<a name="l00106"></a>00106     cOutVector dataLengths;
<a name="l00107"></a>00107     cOutVector erroneousSymbols;
<a name="l00108"></a>00108     cOutVector sentPulses;
<a name="l00109"></a>00109     cOutVector receivedPulses;
<a name="l00110"></a>00110     cOutVector meanPacketBER;
<a name="l00111"></a>00111     cOutVector packetSuccessRate;
<a name="l00112"></a>00112     cOutVector packetSuccessRateNoRS;
<a name="l00113"></a>00113     cOutVector ber;
<a name="l00114"></a>00114     cStdDev meanBER;
<a name="l00115"></a>00115     cOutVector RSErrorRate;
<a name="l00116"></a>00116     cOutVector success, successNoRS;
<a name="l00117"></a>00117 
<a name="l00118"></a>00118     <span class="keywordtype">long</span> nbReceivedPacketsNoRS, nbReceivedPacketsRS;
<a name="l00119"></a>00119     <span class="keywordtype">long</span> nbSentPackets;
<a name="l00120"></a>00120     <span class="keywordtype">long</span> nbSymbolErrors, nbSymbolsReceived;
<a name="l00121"></a>00121     <span class="keywordtype">long</span> nbHandledRxPackets;
<a name="l00122"></a>00122     <span class="keywordtype">long</span> nbFramesDropped;
<a name="l00123"></a>00123 
<a name="l00124"></a>00124     <span class="comment">// warning: cfg value is currently ignored</span>
<a name="l00125"></a>00125     <span class="keywordtype">void</span> prepareData(<a class="code" href="a00224.html">UWBIRMacPkt</a>* packet, <a class="code" href="a00051.html" title="currently unused">IEEE802154A::config</a> cfg = IEEE802154A::cfg_mandatory_4M);
<a name="l00126"></a>00126 
<a name="l00127"></a>00127     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00026.html#a413375cec02b990a521b62086a02264c">handleLowerMsg</a>(cMessage *msg);
<a name="l00128"></a>00128 
<a name="l00129"></a>00129     <span class="keywordtype">bool</span> validatePacket(<a class="code" href="a00224.html">UWBIRMacPkt</a> * mac);
<a name="l00130"></a>00130 
<a name="l00131"></a>00131     <span class="keywordtype">void</span> initCounters();
<a name="l00132"></a>00132 
<a name="l00133"></a>00133 };
<a name="l00134"></a>00134 
<a name="l00135"></a>00135 <span class="preprocessor">#endif // UWBIRMAC_H</span>
<a name="l00136"></a>00136 <span class="preprocessor"></span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>UWBIRMac.h</b>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:30 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
